IRIX Base Documentation 2001 May/SGI IRIX Base Documentation 2001 May.iso/usr/share/catman/p_man/cat3/ifl/iflDatabase.z/iflDatabase

Text File | 1998-10-20 | 9.3 KB | 265 lines

iiiiffffllllDDDDaaaattttaaaabbbbaaaasssseeee((((3333))))    IIIImmmmaaaaggggeeee FFFFoooorrrrmmmmaaaatttt LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll     iiiiffffllllDDDDaaaattttaaaabbbbaaaasssseeee((((3333))))



NNNNAAAAMMMMEEEE
     iiiiffffllllDDDDaaaattttaaaabbbbaaaasssseeee - access to image file format database

IIIINNNNHHHHEEEERRRRIIIITTTTSSSS FFFFRRRROOOOMMMM
     This is a base class with no inheritance.


HHHHEEEEAAAADDDDEEEERRRR FFFFIIIILLLLEEEE
     #include <il/iflDatabase.h>


CCCCLLLLAAAASSSSSSSS DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
     iflDatabase is a lightweight version of the iflFormat class, with
     abbreviated functionality.  Basically, the information here is what can
     be obtained from variables in the file format database without opening
     the specific DSO.  Looking up an object of this class will never cause a
     DSO to be opened.  The intended use is by apps who know they only need
     the restricted methods provided here.

     Refer to the iflFormat(3) man page for more detail on iflFormat
     functionality.

CCCCLLLLAAAASSSSSSSS MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN SSSSUUUUMMMMMMMMAAAARRRRYYYY
   FFFFoooorrrrmmmmaaaatttt llllooooooookkkkuuuupppp
          static iflDatabase* findNext(int& index)
          static iflDatabase* findByMagic(int fd)
          static iflDatabase* findByFormatName(const char* formatName)
          static iflDatabase* findByFileName(const char* fileName,
                                             int noMatchRule=TRUE)


   AAAAttttttttrrrriiiibbbbuuuutttteeee qqqquuuueeeerrrriiiieeeessss
          const char* getName()
          const char* getDefaultSuffix()
          const char* getDescription()
          int accessModeIsSupported(int mode)
          const char* getDSOName()
          const char* getInstSubSystem()


   CCCCoooonnnnvvvveeeerrrrssssiiiioooonnnn ttttoooo iiiiffffllllFFFFoooorrrrmmmmaaaatttt
          iflFormat* getFormat(int openDSOifNecessary = TRUE)



FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNNSSSS
     aaaacccccccceeeessssssssMMMMooooddddeeeeIIIIssssSSSSuuuuppppppppoooorrrrtttteeeedddd(((())))

          int accessModeIsSupported(int mode)






                                                                        PPPPaaaaggggeeee 1111






iiiiffffllllDDDDaaaattttaaaabbbbaaaasssseeee((((3333))))    IIIImmmmaaaaggggeeee FFFFoooorrrrmmmmaaaatttt LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll     iiiiffffllllDDDDaaaattttaaaabbbbaaaasssseeee((((3333))))



          This member function tells whether the given access mode (which must
          be one of _O__R_D_O_N_L_Y, _O__W_R_O_N_L_Y, or _O__R_D_W_R) is supported by the
          subclass.

     ffffiiiinnnnddddBBBByyyyFFFFiiiilllleeeeNNNNaaaammmmeeee(((())))

          static iflDatabase* findByFileName(const char* fileName,
                                             int noMatchRule=TRUE)


          This static class member function is used to look up an image file
          format by file name, where the file name is given by the _f_i_l_e_N_a_m_e
          argument.  This is accomplished by matching the tail end of _f_i_l_e_N_a_m_e
          against each value of the suffixes variable given for each image
          file format in the FTR database.  The _n_o_M_a_t_c_h_R_u_l_e argument can be
          used to limit searching to those formats that have no match rule.

     ffffiiiinnnnddddBBBByyyyFFFFoooorrrrmmmmaaaattttNNNNaaaammmmeeee(((())))

          static iflDatabase* findByFormatName(const char* formatName)


          This static class member function is used to look up an image file
          format by name, where the name is given by the _f_o_r_m_a_t_N_a_m_e argument.

     ffffiiiinnnnddddBBBByyyyMMMMaaaaggggiiiicccc(((())))

          static iflDatabase* findByMagic(int fd)


          This static class member function is used to look up an image file
          format by magic number of a given file that is open for reading with
          the file descriptor, _f_d.

     ffffiiiinnnnddddNNNNeeeexxxxtttt(((())))

          static iflDatabase* findNext(int& index)


          This static class member function is used to step through the
          (static, lazily created) list of supported file formats.

     To start searching initialize the _i_n_d_e_x paramter to zero.  It will be
     automatically updated by each call so that successive calls will iterate
     through all available formats.  If there are no more formats, the
     function returns NULL.

          The following example prints the names of all supported formats:

              iflDatabase *db;
              int index = 0;
              while ((db = iflDatabase::findNext(index)) != NULL)



                                                                        PPPPaaaaggggeeee 2222






iiiiffffllllDDDDaaaattttaaaabbbbaaaasssseeee((((3333))))    IIIImmmmaaaaggggeeee FFFFoooorrrrmmmmaaaatttt LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll     iiiiffffllllDDDDaaaattttaaaabbbbaaaasssseeee((((3333))))



                  printf("%s0, db->getName());


     ggggeeeettttDDDDSSSSOOOONNNNaaaammmmeeee(((())))

          const char* getDSOName()


          This member function returns the 'soname' for the DSO that
          implements this format (used internally to pass to ddddllllooooppppeeeennnn()).

     ggggeeeettttDDDDeeeeffffaaaauuuullllttttSSSSuuuuffffffffiiiixxxx(((())))

          const char* getDefaultSuffix()


          This member function returns the default filename suffix (the first
          suffix listed in the "suffixes" declaration for a format in the IFL
          format database). The returned value is a pointer to a static string
          that is valid forever. Note that the returned value may be NULL.

     ggggeeeettttDDDDeeeessssccccrrrriiiippppttttiiiioooonnnn(((())))

          const char* getDescription()


          This member function returns the format description, or NULL if
          there is none.

     ggggeeeettttFFFFoooorrrrmmmmaaaatttt(((())))

          iflFormat* getFormat(int openDSOifNecessary = TRUE)


          This method returns the full iflFormat correspnding to this
          iflDatabase object.  This may involve some overhead the first time a
          particular format is accessed (opening the DSO and such).

     ggggeeeettttIIIInnnnssssttttSSSSuuuubbbbSSSSyyyysssstttteeeemmmm(((())))

          const char* getInstSubSystem()


          This member function returns the inst sub-system that must be
          installed to use this format.  This is used internally to format
          error messages.

     ggggeeeettttNNNNaaaammmmeeee(((())))

          const char* getName()





                                                                        PPPPaaaaggggeeee 3333






iiiiffffllllDDDDaaaattttaaaabbbbaaaasssseeee((((3333))))    IIIImmmmaaaaggggeeee FFFFoooorrrrmmmmaaaatttt LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll     iiiiffffllllDDDDaaaattttaaaabbbbaaaasssseeee((((3333))))



          This member function returns the format name, which is a pointer to
          a static string that is valid forever.

SSSSEEEEEEEE AAAALLLLSSSSOOOO
     iflFormat


















































                                                                        PPPPaaaaggggeeee 4444